/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions copyright [year] [name of copyright owner]".
 *
 * Copyright 2016 ForgeRock AS.
 */

package org.forgerock.openam.notifications;

import java.util.Objects;

/**
 * Immutable representation of a topic identifier.
 *
 * @since 14.0.0
 */
public final class Topic {

    private final String identifier;

    private Topic(String identifier) {
        this.identifier = identifier;
    }

    /**
     * Creates a new instance of topic.
     *
     * @param identifier identifier
     * @return a new topic instance
     */
    public static Topic of(String identifier) {
        return new Topic(identifier);
    }

    /**
     * Gets the topic identifier.
     *
     * @return the identifier
     */
    public String getIdentifier() {
        return identifier;
    }

    @Override
    public boolean equals(Object other) {
        if (this == other) {
            return true;
        }

        if (!(other instanceof Topic)) {
            return false;
        }

        Topic topic = (Topic) other;
        return Objects.equals(identifier, topic.identifier);
    }

    @Override
    public int hashCode() {
        return Objects.hash(identifier);
    }

}
